home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr37 / gh113f.zip / GHEADER.DOC < prev    next >
Text File  |  1995-02-25  |  19KB  |  367 lines
  1.                              GHeader
  2.                   Copyright (c) 1994 Lon E Green
  3.  
  4.         
  5.         Important Note
  6.         --------------
  7.     ***This software my not be used by DOD, Government, or Military Agency***
  8.  
  9.     ***FOR SPITFIRE 3.5 ONLY...Do not use on earlier versions***
  10.  
  11.              Please give me some kind of feedback.................
  12.  
  13.              This software is distributed as a free program.  However,
  14.         if you want continued support and updates to for new releases
  15.         of SpitFire, then please show your appreciation by making a
  16.         contribution.  I myself like to program, but I need to show my
  17.         my wife that I'm not throwing our money away and letting people
  18.         take advantage of our good nature.  I'll use the money to take
  19.         my wife out to dinner, which in turn she'll love and encourage
  20.         me to spend more time programming.  This is a win-win situtation.
  21.         This will ensure future support for newer versions of Spitfire.
  22.  
  23.         LON E GREEN
  24.         PO BOX 944
  25.         FAIRBORN OH 45324
  26.         
  27.         Internet: 74366.2555@Compuserve.Com
  28.         
  29.  
  30.         Alternative to show support
  31.         ---------------------------
  32.              There is an alternative way of showing your satisfaction for
  33.         GHeader.  If you are like me and have very little money, but still
  34.         would like to show your appreciation, then this is an alternative.
  35.         I am an enlisted person in the United States Air Force and much of
  36.         my career depends on me doing community service and other such
  37.         projects.  If you were to send a sinceare letter of appreciation
  38.         to my Unit Commander, this would make me look good to my superiors.
  39.         If you would like to do this, please don't make it sound like I
  40.         soliciated it.  Also since I'm not sure how long I'll be at my
  41.         current assignment, don't send anything to them after January 1996.
  42.         Here is the address:
  43.                               88th Communication Squadron
  44.                               Attn: Commander
  45.                               Wright-Patterson AFB NM 45433
  46.  
  47.         Introduction
  48.         ------------
  49.              Gheader is a companion utility designed to work with the 
  50.         SPITFIRE Bulletin Board System.  Its main purpose is to replace 
  51.         many of those outdated utilities.  It offers many features and
  52.         each feature can be turned off/on.  Here is just a few of its many 
  53.         features: a) Put Headers on SFFILES.BBS and SFFILES.xxx files, b) 
  54.         Make an All Files Listing, c) Make MGLST<x>.CLR/BBS and 
  55.         FILST<x>.CLR/BBS files, d) and a few other options.  It should be
  56.         able to support 9,999 File Areas.  However this has never been 
  57.         tested beyond a few hundred.  If you use this and have over 1000 
  58.         File Areas, please let me know how it works.
  59.         
  60.         
  61.         Usage
  62.         -----
  63.              Gheader can be put in most any directory.   However, if you
  64.         select to use PKZIP or ARJ, they must be in your DOS path.  For 
  65.         more information on defining your DOS paths refer to your DOS 
  66.         documentation.  To run just enter the name GHeader and the config 
  67.         filename.
  68.         Example: GHEADER GHEADER.CFG 
  69.  
  70.              If you use offline files, then you may include the word
  71.         OFFLINE in the date field of your SFFILES.BBS file.  This will
  72.         ensure that the listing is still counted.  If there is a problem
  73.         with this method, let me know.
  74.  
  75.         Example:  FILE.TXT      103,578  OFFLINE   SAMPLE FILE OF TEXT
  76.  
  77.         
  78.         Configuration
  79.         -------------
  80.              Configuration is very simple.  You must create (or edit the 
  81.         existing) configuration file.  You must use any ASCII editor.  Each
  82.         line is very important and anything after a ; will be commented 
  83.         out.  The config file name is unimportant and you may use several 
  84.         different config files to optimize your board accordingly.  An 
  85.         example of using several config files would be to create an all 
  86.         files listing of just certain file areas for adult access.  Here is 
  87.         an example of a standard Config File:
  88.  
  89.         ---------------------------------------------------------------
  90.         
  91.         Electronic Project BBS   ;BBS Name                       Line 1
  92.         Lon Green                ;Sysop Name                     Line 2
  93.         Yes Yes                  ;File size/Delete Not Found     Line 3
  94.         C:\SF\                   ;Path to Spitfire Directory     Line 4
  95.         Yes         ;Put Header on files in Display directory    Line 5
  96.         Yes 1       ;Make Master Files Listing & Area to Put it  Line 6
  97.         Allfiles.LST             ;All Files File Name            Line 7
  98.         Z -ex                    ;Compression Type               Line 8
  99.         1                        ;Header type on SFFILES.BBS     Line 9
  100.         Yes 1                    ;MGLST<x> & Type of Screen      Line 10
  101.         Yes 1                    ;FILST<x> & Type of Screen      Line 11
  102.         All files listing        ;Description for All-Files      Line 12
  103.         10 20 30..35 100         ;Security for MGLST & FILST     Line 13
  104.         14 16 19 22..49          ;File areas to not put headers  Line 14
  105.         14 16 19 22..49          ;Areas to not put in All-Files  Line 15
  106.         Yes 1/10 up/dl Ratio     ;Your comment in Header         Line 16
  107.  
  108.         ---------------------------------------------------------------
  109.         
  110.              That's all there is to it.  Remember anything after the ; will 
  111.         be commented out.  As you can see, a lot can be accomplished from 
  112.         this config file.  Here is a more detailed description of the 
  113.         config file:
  114.         
  115.         Line 1
  116.         Example: Electronic Project BBS
  117.              This is the Line where you would put your BBS Name.
  118.         
  119.         Line 2
  120.         Example: Lon Green
  121.              This is the Line where you would put your Name.
  122.         
  123.         Line 3
  124.         Example: Yes Yes       
  125.         Example: Y N
  126.         Example: N N
  127.              The First Yes is weather or not to replace the File Size 
  128.         indicated in .BBS file with the actual File Size.  If the file is 
  129.         not found, then it will keep the original file size.  The Second 
  130.         Yes is To Determine if the file exist or not, if not it will Delete 
  131.         it from the .BBS listing.  It will not touch the listings in the 
  132.         display directory for CD-ROM Areas.
  133.         **PLEASE NOTE:  This activity will slow down this program
  134.         tremendously!! (but worth it)...
  135.  
  136.         Line 4
  137.         Example: C:\SF\
  138.         Example: D:\SpItFiRe
  139.              This is the path to your Spitfire directory.  The trailing 
  140.         back-slash is optional.  But please ensure you have the full path.
  141.         
  142.         Line 5
  143.         Example: Yes
  144.         Example: No
  145.         Example: Y
  146.              This line turns on the option of putting a header on your
  147.         SFFILES.xxx files in your display directory.  Actually these rarely
  148.         changed because they are CD-ROM files, you should only really need to
  149.         use this option once.  After that you can turn it off.  That way the
  150.         program will run faster thereafter.
  151.         
  152.         Line 6
  153.         Example: Yes 4
  154.         Example: No 1
  155.         Example: Y 7
  156.                  │ └─ File Area to Put All Files In
  157.                  └─── Yes/No - Create an All Files Area
  158.              This option will determine if you want to create an All-Files 
  159.         Listing and the File Area to place it in.  You do not have to spell
  160.         out 'Yes' or 'No'.  A simple 'Y' or 'N' will work.
  161.         
  162.         Line 7
  163.         Example: ALLFILES.LST
  164.         Example: MYBBSNAM.ABC
  165.              This is the name you wish to give to your All-Files Listing.  
  166.         You can change this to make it unique to your board.  Or if 
  167.         multiple config files are used, you can change this to ADULT.LST or 
  168.         SPECIAL.FIL.  
  169.         
  170.         Line 8
  171.         Example: Z
  172.         Example: Z -ex
  173.         Example: A
  174.              This is the type of compression you wish to use.  Z is for 
  175.         PKZIP and A is for ARJ.  If you wish you can put other features 
  176.         here like -ex which is used by PKZIP 2.04g to use Maximum 
  177.         Compression, or you can use it turn off other features like -3 (32 
  178.         bit access).   Ensure you put a space between the Z and the extra 
  179.         features.  Other compression routines will be added if there is a
  180.         request for them.  All you have to do is ask.
  181.         
  182.         Line 9
  183.         Example: 1
  184.              This is the number of the type of header you would like to use 
  185.         with your SFFILES.BBS file.  A '0' would not put any header on
  186.         it.  A zero would be useful if you wished to remove all headers.
  187.  
  188.         (1)
  189. ╔═════════════════════════════════════════════════════════════════════════════╗
  190. ║                            Electronic Project BBS                           ║
  191. ║ Free Files Directory                                      File Area:    1   ║
  192. ║ Total Bytes: 831,649                                    Total Files:    9   ║
  193. ╠═════════════════════════════════════════════════════════════════════════════╣
  194. ║ Filename       Size   Date     File Description         ( GHeader Ver 1.1 ) ║
  195. ╚═════════════════════════════════════════════════════════════════════════════╝
  196.  
  197.         (2)
  198. ╒═════════════════════════════════════════════════════════════════════════════╕
  199. │                            Electronic Project BBS                           │
  200. │ Free Files Directory                                      File Area:    1   │
  201. │ Total Bytes: 831,649                                    Total Files:    9   │
  202. ├─────────────────────────────────────────────────────────────────────────────┤
  203. │ Filename       Size   Date     File Description         ( GHeader Ver 1.1 ) │
  204. ╘═════════════════════════════════════════════════════════════════════════════╛
  205.  
  206.         (3)
  207.                          ┌──────────────────────────┐
  208. ╒════════════════════════╡  Electronic Project BBS  ╞═════════════════════════╕
  209. │                        └──────────────────────────┘                         │
  210. │ Free Files Directory                                      File Area:    1   │
  211. │                                                          ( GHeader Ver 1.1 )│
  212. ╘═════════════════════════════════════════════════════════════════════════════╛
  213.  
  214.         (4)
  215. ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  216. █┌───────────────────────────────────────────────────────────────────────────┐█
  217. █│                     File Area 1 Free Files Directory                      │█
  218. █│                                                                           │█
  219. █│     Total Bytes: 831,649                           Total Files:    9      │█
  220. █└───────────────────────────────────────────────────────────────────────────┘█
  221. ███████████████████████████████████████████████████████████████████████████████
  222. █┌───────────────────────────────────────────────────────────────────────────┐█
  223. █│  Filename     Size   Date     File Description         ( GHeader Ver 1.1 )│█
  224. █└───────────────────────────────────────────────────────────────────────────┘█
  225. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  226.  
  227.         (5)
  228. ╒═══════════════════════════════════════════════════════════════════════════╕
  229. │                          Electronic Project BBS                           │█
  230. │                                                                           │█
  231. │                     File Area 1 Free Files Directory                      │█
  232. ╞═══════════════════════════════════════════════════════════════════════════╡█
  233. │     Total Bytes: 831,649                           Total Files:    9      │█
  234. ╞═══════════════════════════════════════════════════════════════════════════╡█
  235. │  Filename     Size    Date     File Description        ( GHeader Ver 1.1 )│█
  236. ╘═══════════════════════════════════════════════════════════════════════════╛█
  237.   ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  238.  
  239.         (6)
  240. ╒═══════════════════════════════════════════════════════════════════════════╕
  241. │                     File Area 1 Free Files Directory                      │█
  242. │                                                                           │█
  243. │     Total Bytes: 831,649                           Total Files:    9      │█
  244. ╞═══════════════════════════════════════════════════════════════════════════╡█
  245. │  Filename     Size    Date     File Description        ( GHeader Ver 1.1 )│█
  246. ╘═══════════════════════════════════════════════════════════════════════════╛█
  247.   ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  248.  
  249.         (7)
  250. ╒═══════════════════════════════════════════════════════════════════════════╕
  251. │                     File Area 1 Free Files Directory                      │█
  252. │                                                                           │█
  253. │     Total Bytes: 831,649                           Total Files:    9      │█
  254. ╘═══════════════════════════════════════════════════════════════════════════╛█
  255.   ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  256.       ╒══════════════════════════════════════════════════════════════════╕    
  257. ╒═════╡ Use This Letter To Tag Files For Download..NO Comma Is Necessary │█   
  258. │     ╘══════════════════════════════════════════════════════════════════╛█   
  259. │      ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀   
  260. │╒══════════════════════════════════════════════════════════════════════════╕ 
  261. ││ Filename     Size    Date     File Description        ( GHeader Ver 1.1 )│█
  262. │╘══════════════════════════════════════════════════════════════════════════╛█
  263.   ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  264.  
  265.         Line 10
  266.         Example: Yes 3
  267.         Example: N 2
  268.         Example: Y 1
  269.                  │ └─ Which screen format to use.
  270.                  └─── Do you want the screens generated?
  271.              This switch is used to turn on/off the creation of your 
  272.         MGLST<x>.CLR/.BBS files.  (See your Spitfire Docs for more 
  273.         information on MGLST<x> files.) The Number is the type of
  274.         display that you wish to use. (only 1 through 7)
  275.         
  276.         Line 11
  277.         Example: N 2
  278.         Example: Y 1
  279.                  │ └─ Which screen format to use.
  280.                  └─── Do you want the screens generated?
  281.              This switch is used to turn on/off the creation of your 
  282.         FILST<x>.CLR/.BBS files.  (See your Spitfire Docs for more informa-
  283.         tion on FILST<x> files.)  The number is the type of display that
  284.         you wish to use.  File Areas that you exclude in line 15 will not
  285.         be included here either.  (only 1 through 7)
  286.  
  287.         Line 12
  288.         Example: All Adult Files For The ABC BBS
  289.              This entry is used to write the description of your All-Files 
  290.         File in the SFFILES.BBS file in the area entered in Line 9.  This 
  291.         can also be used for multiple Config Files.
  292.         
  293.         Line 13
  294.         Example: 10 20 30..35 100
  295.              These are the access levels used to create your MGLST<x> and 
  296.         FILST<x> files.  Enter each one separated by a space.  If you have 
  297.         a series of access levels (like 30 31 32 33 34 35) you can enter 
  298.         them like this: 30..35    That will take care of all of them from 
  299.         30 through 35.
  300.         
  301.         Line 14
  302.         Example: 12 14 16 22..29 50..55
  303.              These are the File Areas you wish to 'NOT' put Headers on.
  304.         GHeader can handle 9,999 file areas.  This is useful for test 
  305.         areas, Inactive areas, Adult areas, and areas defined in Spitfire,
  306.         but don't really exist.  A series of several numbers can be
  307.         entered as 20..25 which would cover 20 through 25.
  308.         
  309.         Line 15
  310.         Example: 12 14 16 22..29 50..55
  311.              These are the file areas you wish to 'NOT' put in your All-Files
  312.         Listing.  GHeader can handle 9,999 file areas.  Again, sequenced 
  313.         numbers can be entered like this: 22..29 as long as you do not want 
  314.         all the areas from 22 through 29 listed in the All-Files Listing.  
  315.         This is also useful in multiple config files.  This also effects 
  316.         Line 11 in the Config File by not putting a header on that area.
  317.         
  318.         Line 16
  319.         Example: N
  320.         Example: Y Remember this system has a 1 to 20 u/d Raito
  321.         Example: N Nothing will be displayed because I selected 'N'.
  322.                  │ └─ This is your message up to 70 characters long.
  323.                  └─── Do you want this message?
  324.              This is used to put your own comments in the Headers of the
  325.         .BBS files.  Your Message can be up to 70 characters long.  If
  326.         you do not wish to insert a message in the Headers, then select 'N'.
  327.  
  328.         Special Feature
  329.         ---------------
  330.              There is one special feature in this program.  If you have a 
  331.         CD-ROM and have set up the paths in Spitfire, and the directories 
  332.         in the CD-ROM contain a SFFILES.BBS file, this option will find
  333.         that file, copy it to your Display directory with the correct
  334.         SFFILES.xxx and put a header on it.  I primarily put this in for
  335.         myself, because I am lazy and hate doing that.  To use this
  336.         option, ensure Line 5 has a YES, then enter:
  337.            GHEADER GHEADER.CFG UPDATEFROMCDROM
  338.         The UPDATEFROMCDROM has to be in all caps for it to work.  
  339.         
  340.         
  341.         Special Thanks
  342.         --------------
  343.              Special thanks to Mike Woltz for his creation of the Spitfire 
  344.         Bulletin Board System. To Robert K Jung for his creation of the ARJ 
  345.         compression program.  To PKWare for the creation of the PKZIP 
  346.         compression program.
  347.  
  348.         Also a big thanks to my initial Beta Testers for risking it all:
  349.           Bill Harms            Dragon Mountain BBS
  350.           Fred Partridge        SezMe Street BBS
  351.           Cary Conover          The Shareware Shoppe BBS
  352.           Steve Broughton       Mustang Country BBS
  353.         
  354.         Disclaimer
  355.         ----------
  356.              GHeader is only guaranteed to take up room on your disk.  
  357.         There are no warranties, either expressed or implied, with respect 
  358.         to the software, its quality, performance, usefulness, or fitness 
  359.         for any particular purpose.  This software is provided "as is" and 
  360.         the entire risk as to its quality and performance is with the user.  
  361.         The author of this software shall not be liable for errors 
  362.         contained in the software or the software's documentation, or for 
  363.         incidental or consequential damages of any kind in connection with 
  364.         the performance, use, or possession  of this software.  
  365.  
  366.         SpitFire is a Copyright of Buffalo Creek Software and Mike Woltz
  367.